Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update paimon.md #1472

Merged
merged 6 commits into from
Feb 10, 2022
Merged

Update paimon.md #1472

merged 6 commits into from
Feb 10, 2022

Conversation

zpaimon
Copy link
Contributor

@zpaimon zpaimon commented Feb 10, 2022

Please make sure to check the following boxes creating your pull request, thank you very much!

  • Add Blog Header, including title, author, image, categories, tags, etc.

    For example:

    ---
    title: Your Great Blog Title
    author: your_github_id
    categories: project
    tags:
      - python
      - padlocal
    image: /assets/2021/02-your-blog-slug/teaser.jpg
    ---
    
    One line bio
    
    Your blog post content Your blog post content
    Your blog post content Your blog post content
    Your blog post content Your blog post content

    It will be easier to start drafting your post by using a existing post file as your template, for example, this one

  • Keep all filenames lowercase, and use - to connect words instead of space. e.g. 2017-10-06-wechat-pc-impactor.md instead of 2017-10-06-WeChat PC Impactor.md

  • Embed video/pdf from YouTube/Bilibili/local (if there's any) by using {% include iframe.html src="URL_or_PATH" %}. (Learn more about how to embed file/url in the post by reading this blog post

  • Save photo to local before publishing, to a folder named by ${MONTH}-${YOUR_BLOG_SLUG}/ under /assets/2021/ directory.

  • Select a beautiful and meaningful teaser image for your blog

  • Create your contributor profile (if you are a first time contributor)

    For excample:

    jekyll/_contributors/lijiarui.md

    ---
    name: Jiarui LI (李佳芮)
    site: https://lijiarui.github.io
    bio: 句子互动创始人 & CEO,微软人工智能最具价值专家 (AI MVP)
    avatar: /jekyll/assets/contributors/lijiarui/avatar.png
    email: rui@juzi.bot
    twitter: https://weibo.com/u/2175505900
    ---

    Here is the example file:

To learn more about the contribute guideline, visit: https://wechaty.js.org/docs/contributor-program/

huan
huan previously approved these changes Feb 10, 2022
Copy link
Member

@huan huan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thank you very much for improving the Paimon WPS, the example code looks great and it will definitely help new users to getting started!

@huan huan enabled auto-merge (squash) February 10, 2022 03:24
auto-merge was automatically disabled February 10, 2022 03:24

Head branch was pushed to by a user without write access

@huan huan enabled auto-merge (squash) February 10, 2022 03:24
Copy link
Member

@huan huan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example code is using the Wechaty v0.x API, which can not work with the latest Wechaty v1.x.

My suggestion will be:

  1. use the Wechaty v1.x API to prevent confusion when a user is getting started
  2. use TypeScript so that the code can be static typing
  3. use ESM so that we can use the import as well as the top-level async/await (ESM will be the default after Wechaty v2.0, and the require might be deprecated)

@zpaimon
Copy link
Contributor Author

zpaimon commented Feb 10, 2022

I want keep it so simple.Some users can't understand typescript.

auto-merge was automatically disabled February 10, 2022 03:51

Head branch was pushed to by a user without write access

@huan huan merged commit 4f228fd into wechaty:main Feb 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants